allow manual initialization and config as code #1149

erquhart · 2018-03-01T04:12:43Z

- Summary

This pull request solves at least two problems:

The CMS immediately runs on load, leaving no opportunity for bootstrapping.
The CMS config cannot be directly provided as a JS object.

These are both relevant concerns for customizing Netlify CMS for specific static site generators, where we could potentially infer an entire configuration based on SSG conventions, and have no easy way to inject the configuration.

- Description for the changelog

allow manual initialization and config injection

- Notes for reviewers

There are PR comments explaining why changes took place for most individual files. Here are the high points:

Config action payloads are now Immutable maps
Config action payloads used to be objects, and conversion took place in the reducer. This sort of worked, but we now need to load in pieces of configuration one or more times before fetching config.yml, and then run validation and whatnot, so now we convert to Immutable right away before doing anything else. A large portion of changes are due to this.

Default config state is set to { isFetching: true }
The app used to first check for a non-null config state, and then for isFetching to be false, before loading up. Now that config can be injected during bootstrapping, these are both false positives. Setting isFetching to true by default lets us avoid a lot of changes in how we handle configuration state.

A secondary entry point
We'll now be distributing init.js, which exports init and registry functions. The init function accepts an optional object, which is currently only expected to contain an object at the config key. The registry function can be used before or after initialization.

Public beta features
Finally, this PR introduces an approach for public betas. We simply release the beta feature and document it in the Beta Features section of the docs, which carries a clear disclaimer. The new docs page is added with this PR, here's the preview: https://deploy-preview-1149--netlify-cms-www.netlify.com/docs/beta-features/

verythorough · 2018-03-01T04:15:19Z

Deploy preview for netlify-cms-www ready!

Built with commit c5feb8b

https://deploy-preview-1149--netlify-cms-www.netlify.com

verythorough · 2018-03-01T04:17:56Z

Deploy preview for cms-demo ready!

Built with commit c5feb8b

https://deploy-preview-1149--cms-demo.netlify.com

erquhart · 2018-03-01T04:30:43Z

I'll update the config spec to get tests passing in the am.

erquhart · 2018-03-01T21:18:03Z

package.json

@@ -41,7 +41,6 @@
    "setupFiles": [
      "./setupTests.js"
    ],
-    "mapCoverage": true,


No longer required in Jest 22.

erquhart · 2018-03-01T21:19:11Z

package.json

-    "jest": "^21.2.1",
-    "jest-cli": "^21.2.1",
+    "jest": "^22.0.0",
+    "jest-cli": "^22.0.0",
    "lint-staged": "^3.3.1",


Jest updated for fix of toEqual requiring matching order when comparing maps.

erquhart · 2018-03-01T21:21:16Z

src/actions/__tests__/config.spec.js

@@ -1,117 +1,120 @@
+import { fromJS } from 'immutable';


Causes for change in this file:

Config objects are now converted to immutable maps before processing, so functions like applyDefaults now expect a map.

The isFetching config state value is now true by default.

erquhart · 2018-03-01T21:24:55Z

src/actions/config.js

 import { authenticateUser } from "Actions/auth";
 import * as publishModes from "Constants/publishModes";

 export const CONFIG_REQUEST = "CONFIG_REQUEST";
 export const CONFIG_SUCCESS = "CONFIG_SUCCESS";
 export const CONFIG_FAILURE = "CONFIG_FAILURE";
+export const CONFIG_MERGE = "CONFIG_MERGE";


Allows configuration to be merged into the state without triggering CONFIG_SUCCESS, which should only occur after an intentional configuration retrieval cycle.

erquhart · 2018-03-01T21:31:05Z

src/actions/config.js

@@ -1,50 +1,63 @@
 import yaml from "js-yaml";


Causes for change in this file:

Config objects are now converted to immutable maps before processing.

We must now differentiate between merging a config value into state and loading config state into the application, since state values could be merged in an arbitrary number of times before the final configuration state is ready.

erquhart · 2018-03-01T21:32:32Z

src/bootstrap.js

@@ -0,0 +1,67 @@
+import React from 'react';


This file is simply a paste of the core application initialization code that used to be in index.js. It was created to be shared between index.js for auto init, and init.js for manual init.

erquhart · 2018-03-01T21:33:18Z

src/index.js

@@ -1,54 +1,16 @@
-import React from 'react';


Changes to this file are limited to moving the core initialization out to bootstrap.js.

erquhart · 2018-03-01T21:34:34Z

src/init.js

@@ -0,0 +1,7 @@
+/**


This file will be distributed in our npm module, and provides functions for retrieving the manual initialization function and registry.

erquhart · 2018-03-01T21:35:37Z

src/reducers/collections.js

@@ -1,4 +1,4 @@
-import { OrderedMap, fromJS } from 'immutable';


Causes for change in this file:

action.payload is now an immutable map instead of an object.

Logic needed a little cleanup.

erquhart · 2018-03-01T21:37:08Z

src/reducers/config.js

@@ -1,14 +1,21 @@
-import Immutable from 'immutable';


Causes for change in this file:

action.payload is an immutable map instead of an object.

isFetching is set to true by default.

State can be merged prior to configuration finalization.

erquhart · 2018-03-04T01:33:22Z

Docs: https://deploy-preview-1149--netlify-cms-www.netlify.com/docs/beta-features/

verythorough · 2018-03-06T01:56:50Z

Cool idea. Docs LGTM. 👍

erquhart force-pushed the manual-init branch from 88e2e6a to fe8ad97 Compare March 1, 2018 21:17

erquhart commented Mar 1, 2018

View reviewed changes

allow manual initialization and config as an arg

b61f41c

erquhart force-pushed the manual-init branch from fe8ad97 to b61f41c Compare March 1, 2018 22:04

erquhart added area: build kind: enhancement impact: changelog area: configuration status: 2-code-review labels Mar 1, 2018

erquhart force-pushed the manual-init branch from 0c0f67e to cb5b12f Compare March 2, 2018 02:14

add manual init docs

c5feb8b

erquhart force-pushed the manual-init branch from cb5b12f to c5feb8b Compare March 4, 2018 01:24

erquhart merged commit c31aaae into master Mar 6, 2018

erquhart deleted the manual-init branch March 6, 2018 21:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

allow manual initialization and config as code #1149

allow manual initialization and config as code #1149

erquhart commented Mar 1, 2018 •

edited

Loading

verythorough commented Mar 1, 2018 •

edited

Loading

verythorough commented Mar 1, 2018 •

edited

Loading

erquhart commented Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018 •

edited

Loading

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart Mar 1, 2018

erquhart commented Mar 4, 2018

verythorough commented Mar 6, 2018

		@@ -1,4 +1,4 @@
		import { OrderedMap, fromJS } from 'immutable';

allow manual initialization and config as code #1149

allow manual initialization and config as code #1149

Conversation

erquhart commented Mar 1, 2018 • edited Loading

verythorough commented Mar 1, 2018 • edited Loading

verythorough commented Mar 1, 2018 • edited Loading

erquhart commented Mar 1, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart Mar 1, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erquhart commented Mar 4, 2018

verythorough commented Mar 6, 2018

erquhart commented Mar 1, 2018 •

edited

Loading

verythorough commented Mar 1, 2018 •

edited

Loading

verythorough commented Mar 1, 2018 •

edited

Loading

erquhart Mar 1, 2018 •

edited

Loading